/*
 * Copyright 2011 Clean GWT
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.cleangwt.user.cellview.client;

import com.cleangwt.json.client.SimpleObject;
import com.google.gwt.core.shared.GWT;
import com.google.gwt.resources.client.ImageResource;
import com.google.gwt.resources.client.ImageResource.ImageOptions;
import com.google.gwt.view.client.ProvidesKey;

/**
 * The styled {@link com.google.gwt.user.cellview.client.DataGrid} with data type of
 * {@link SimpleObject}.
 * 
 * @author Jess
 * @version 1.0
 * @since 1.0
 */
public final class DataGrid extends com.google.gwt.user.cellview.client.DataGrid<SimpleObject> {

  interface Resources extends com.google.gwt.user.cellview.client.DataGrid.Resources {
    /**
     * The loading indicator used while the table is waiting for data.
     */
    @Source("cellTableLoading.gif")
    @ImageOptions(flipRtl = true)
    ImageResource dataGridLoading();

    /**
     * The styles used in this widget.
     */
    @Override
    @Source("DataGrid.css")
    Style dataGridStyle();
  }

  private static final Resources RESOURCES = GWT.create(Resources.class);
  private static final int DEFAULT_PAGESIZE = 50;

  /**
   * Constructs a table with a default page size of 50.
   */
  public DataGrid() {
    this(DEFAULT_PAGESIZE);
  }

  /**
   * Constructs a table with the given page size.
   * 
   * @param pageSize the page size
   */
  public DataGrid(int pageSize) {
    this(pageSize, null);
  }

  /**
   * Constructs a table with the given page size and the given {@link ProvidesKey key provider}.
   * 
   * @param pageSize the page size
   * @param keyProvider an instance of ProvidesKey<T>, or null if the record object should act as
   *          its own key
   */
  public DataGrid(int pageSize, ProvidesKey<SimpleObject> keyProvider) {
    super(pageSize, RESOURCES, keyProvider);
  }

}
